Fix always scrollable suggestion list #35319

MrRefactor · 2024-01-29T15:43:43Z

Details

This PR concentrates on fixing the unwanted behaviour of always-scrollable suggestion list, which was introduced in the workaround. We are keeping previous fix on native android and iOS safari due to the fact that, the previous workaround is fixing other issue connected with broken scroll on these platforms.

Fixed Issues

$ #27866
PROPOSAL: #27866 (comment)

Tests

Open chat
Type "@" followed by the search keyword in the compose field.
Ensure that the suggestion list ONLY returns a FEW results so that the scroll bar doesn't appear.
Scroll the suggestion list up and down
Verify that scrolling over mention list will not scroll behind

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android-native.mov

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web-chrome.mov

web-safari.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-02-01T08:54:10Z

@amyevans Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

amyevans · 2024-02-01T18:37:18Z

@Santhosh-Sellavel looks like this one is ready for you, thanks!

Santhosh-Sellavel · 2024-02-02T06:44:35Z

Will check today

src/styles/utils/index.ts

Santhosh-Sellavel

Can you add & update comments, comments are same on all files.

Santhosh-Sellavel · 2024-02-13T20:39:56Z

    if (platform === 'android' || isMobileSafari) {
        top += borderWidth;
    } else {
        height += borderWidth;
    }

This is the platform-specific logic, look for ways to simplify this break into platform-specific methods instead of making code duplicate.

MrRefactor · 2024-02-13T20:41:37Z

    if (platform === 'android' || isMobileSafari) {
        top += borderWidth;
    } else {
        height += borderWidth;
    }
This is the platform-specific logic, look for ways to simplify this break into platform-specific methods instead of making code duplicate.

I think you are looking at older commit, now its only checking type of web browser

Santhosh-Sellavel · 2024-02-13T20:48:39Z

Yeah, that was from an old commit, we need to update correct height/top style for different platforms. Different wrappers in platform specific code to update them if required in implementions otherwise NOOP just return

MrRefactor · 2024-02-14T12:54:18Z

@situchan Hi! I have a question to the implementation I created - due the the face that we are splitting worklet into platform specific files, we cannot create additional methods to update the worklet on the go due to the fact that worklets wre running on the separated thread, how should I modify the code in that case?

situchan · 2024-02-15T22:35:20Z

@situchan Hi! I have a question to the implementation I created - due the the face that we are splitting worklet into platform specific files, we cannot create additional methods to update the worklet on the go due to the fact that worklets wre running on the separated thread, how should I modify the code in that case?

I don't like that approach. Most of codes are same but separated.
Can you keep worklet in original file and split only minor piece of code into platform specific files?

situchan · 2024-02-21T11:05:42Z

@MrRefactor kindly bump #35319 (comment)

MrRefactor · 2024-02-21T11:31:40Z

@MrRefactor kindly bump #35319 (comment)

Working on other solution rn, will push changes soon

MrRefactor · 2024-02-21T13:26:47Z

@situchan Hi! I have a question to the implementation I created - due the the face that we are splitting worklet into platform specific files, we cannot create additional methods to update the worklet on the go due to the fact that worklets wre running on the separated thread, how should I modify the code in that case?

I don't like that approach. Most of codes are same but separated. Can you keep worklet in original file and split only minor piece of code into platform specific files?

I tried that approach, but due to the fact that worklets are running on UI thread, its preventing us from usage of functions inside them that are working on main thread. There was a useWorkletCallback hook provided by reanimated, but its deprecated.

situchan · 2024-02-21T13:39:47Z

I was expecting super simple solution. Won't this work?

+ const canUseTouchScreen = DeviceCapabilities.canUseTouchScreen();

...

    'worklet';

    const borderWidth = 2;
-   const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING;
+   const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING + (canUseTouchScreen ? 0 : borderWidth);

    // The suggester is positioned absolutely within the component that includes the input and RecipientLocalTime view (for non-expanded mode only). To position it correctly,
    // we need to shift it by the suggester's height plus its padding and, if applicable, the height of the RecipientLocalTime view.
    return {
        overflow: 'hidden',
-       top: -(height + CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_PADDING + borderWidth),
+       top: -(height + CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_PADDING + (canUseTouchScreen ? borderWidth : 0)),
        height,
        minHeight: CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTION_ROW_HEIGHT,
    };

MrRefactor · 2024-02-21T13:45:38Z

I was expecting super simple solution. Won't this work?

+ const canUseTouchScreen = DeviceCapabilities.canUseTouchScreen();

...

    'worklet';

    const borderWidth = 2;
-   const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING;
+   const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING + (canUseTouchScreen ? 0 : borderWidth);

    // The suggester is positioned absolutely within the component that includes the input and RecipientLocalTime view (for non-expanded mode only). To position it correctly,
    // we need to shift it by the suggester's height plus its padding and, if applicable, the height of the RecipientLocalTime view.
    return {
        overflow: 'hidden',
-       top: -(height + CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_PADDING + borderWidth),
+       top: -(height + CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_PADDING + (canUseTouchScreen ? borderWidth : 0)),
        height,
        minHeight: CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTION_ROW_HEIGHT,
    };

there are different values for native android, native iOS as well as mobile chrome, mobile safari and web so we cant implement it like that

situchan · 2024-02-21T13:47:49Z

native android, native iOS as well as mobile chrome, mobile safari

Why can't keep all values same between these platforms? I understand that they're still unnecessarily scrollable on iOS

But the main bug we're trying to fix is to hide scroll bar on web, isn't it?

situchan · 2024-02-21T13:50:43Z

If still persisting platform specific values, we can create platform files in /libs folder file similar to canUseTouchScreen

And just update code like this:

const height = itemsHeight + 2 * CONST.AUTO_COMPLETE_SUGGESTER.SUGGESTER_INNER_PADDING + (shouldPreventScrollOnAutoCompleteSuggestion ? borderWidth : 0);

MrRefactor · 2024-02-21T13:52:35Z

native android, native iOS as well as mobile chrome, mobile safari

Why can't keep all values same between these platforms? I understand that they're still unnecessarily scrollable on iOS

But the main bug we're trying to fix is to hide scroll bar on web, isn't it?

This PR introduced fix for bug with scroll on android and regression for other platforms. This PR is to keep fix on android and mobile Safari, then revert it on other platforms - iOS, mobile Chrome, Web, Desktop. So we are fixing the regression not only on Web

situchan · 2024-02-21T13:53:16Z

@MrRefactor please check #35319 (comment)

situchan · 2024-02-21T13:57:19Z

#35953 is a good example for your reference

MrRefactor · 2024-02-21T14:28:08Z

#35953 is a good example for your reference

Added changes

situchan · 2024-02-21T14:40:57Z

@MrRefactor thanks for applying my approach. Please merge main (7k+ commits are behind)

MrRefactor · 2024-02-21T14:51:36Z

@MrRefactor thanks for applying my approach. Please merge main (7k+ commits are behind)

merged!

MrRefactor · 2024-02-21T17:12:54Z

Merge didnt impact changes from this PR, working as expected @situchan

situchan · 2024-02-21T17:48:34Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

melvin-bot · 2024-02-21T17:49:16Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #37038.

situchan · 2024-02-21T17:51:07Z

@MrRefactor please do this change:

### Fixed Issues

- $ #27866
+ $ https://github.com/Expensify/App/issues/27866

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.tsx

MrRefactor · 2024-02-21T17:56:20Z

@MrRefactor please do this change:

### Fixed Issues

- $ #27866
+ $ https://github.com/Expensify/App/issues/27866

done

situchan

Looks good!

OSBotify · 2024-02-26T21:05:17Z

🚀 Deployed to staging by https://github.com/francoisl in version: 1.4.44-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

kavimuru · 2024-02-27T22:59:51Z

Failing in mweb with #27866. Evidence attached.

https://platform.applause.com/services/links/v1/external/a49e9b282aa159197115669cd25164941955a6886471bf5bd290b19c5ed5e6eb

situchan · 2024-02-28T06:12:01Z

Failing in mweb with #27866. Evidence attached.

https://platform.applause.com/services/links/v1/external/a49e9b282aa159197115669cd25164941955a6886471bf5bd290b19c5ed5e6eb

It's expected. mSafari should behave same as production.

OSBotify · 2024-02-28T23:53:53Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Fix always scrollable suggestion list

16bd5cd

MrRefactor marked this pull request as ready for review February 1, 2024 08:53

MrRefactor requested a review from a team as a code owner February 1, 2024 08:53

melvin-bot bot requested review from amyevans and removed request for a team February 1, 2024 08:54

MrRefactor mentioned this pull request Feb 1, 2024

[$500] Chat - The user is able to scroll through the suggestion list #27866

Closed

6 tasks

amyevans requested review from Santhosh-Sellavel and removed request for amyevans February 1, 2024 18:36

Santhosh-Sellavel suggested changes Feb 2, 2024

View reviewed changes

src/styles/utils/index.ts Outdated Show resolved Hide resolved

MrRefactor added 2 commits February 13, 2024 12:09

Split autoCompleteSuggestionContainerStyle to platform files

439336b

Prettier fixes

b90c64c

Santhosh-Sellavel suggested changes Feb 13, 2024

View reviewed changes

francoisl requested a review from situchan February 13, 2024 22:38

Implement shouldPreventScrollOnAutoCompleteSuggestion function

972084d

Merge branch 'main' into proposal/27866

7220ea1

situchan approved these changes Feb 21, 2024

View reviewed changes

melvin-bot bot mentioned this pull request Feb 21, 2024

[PAY 07/03] Payment issue for E/App PR#35319 #37038

Closed

situchan reviewed Feb 21, 2024

View reviewed changes

src/components/AutoCompleteSuggestions/BaseAutoCompleteSuggestions.tsx Outdated Show resolved Hide resolved

Prettier fix

9610f7c

situchan approved these changes Feb 21, 2024

View reviewed changes

melvin-bot bot requested a review from francoisl February 21, 2024 17:58

francoisl approved these changes Feb 21, 2024

View reviewed changes

francoisl merged commit 786b7ab into Expensify:main Feb 21, 2024
17 checks passed

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix always scrollable suggestion list #35319

Fix always scrollable suggestion list #35319

MrRefactor commented Jan 29, 2024 •

edited

Loading

melvin-bot bot commented Feb 1, 2024

amyevans commented Feb 1, 2024

Santhosh-Sellavel commented Feb 2, 2024

Santhosh-Sellavel left a comment

Santhosh-Sellavel commented Feb 13, 2024

MrRefactor commented Feb 13, 2024

Santhosh-Sellavel commented Feb 13, 2024

MrRefactor commented Feb 14, 2024

situchan commented Feb 15, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

situchan commented Feb 21, 2024 •

edited

Loading

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

situchan left a comment

melvin-bot bot commented Feb 21, 2024

situchan commented Feb 21, 2024 •

edited

Loading

MrRefactor commented Feb 21, 2024

situchan left a comment

OSBotify commented Feb 26, 2024

kavimuru commented Feb 27, 2024

situchan commented Feb 28, 2024

OSBotify commented Feb 28, 2024

Fix always scrollable suggestion list #35319

Fix always scrollable suggestion list #35319

Conversation

MrRefactor commented Jan 29, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 1, 2024

amyevans commented Feb 1, 2024

Santhosh-Sellavel commented Feb 2, 2024

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Feb 13, 2024

MrRefactor commented Feb 13, 2024

Santhosh-Sellavel commented Feb 13, 2024

MrRefactor commented Feb 14, 2024

situchan commented Feb 15, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

situchan commented Feb 21, 2024 • edited Loading

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

MrRefactor commented Feb 21, 2024

situchan commented Feb 21, 2024

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Feb 21, 2024

situchan commented Feb 21, 2024 • edited Loading

MrRefactor commented Feb 21, 2024

situchan left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 26, 2024

kavimuru commented Feb 27, 2024

situchan commented Feb 28, 2024

OSBotify commented Feb 28, 2024

MrRefactor commented Jan 29, 2024 •

edited

Loading

situchan commented Feb 21, 2024 •

edited

Loading

situchan commented Feb 21, 2024 •

edited

Loading